<?php
/* 
 * Copyright (c) 2011 Antoine d'Otreppe de Bouvette
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

/**
 * The C part of MVC. Use this class as a base for your controllers. 
 */
abstract class Controller {
    /**
     * @var URLWriter
     */
    private $urlWriter;
    
    /**
     * @var TemplateRenderer
     */
    private $templateRenderer;
    
    /**
     *
     * @var Logger
     */
    private $logger;
    
    /**
     * Returns the render of a template in a response.
     * 
     * @param string $template The name of the template to be rendered
     * @param Request $request
     * @param array $vars
     * @param array $inheritable
     * @return RenderMeResponse
     */
    protected function render($template, array $vars=array()) {
        $response = new RenderMeResponse();
        $response->setTemplateRenderer($this->templateRenderer);
        $response->setVars($vars);
        $response->setTemplate($template);
        
        return $response;
    }
    
    public function __toString() {
    	return get_class($this);
    }
    
    /**
     * @param type $route
     * @param ArrayTransformer $param
     * @throws HTTPRedirectError
     */
    protected function redirect($route, $param=null) {
        $url = $this->urlWriter->urlTo($route, $param);
        
        throw new HTTPRedirectError($url);
    }
    
    /**
     * @param Request $request 
     * @return void
     */
    public function preExec(Request $request) {
        // Nothing done here. To be overridden by children classes
    }
    
    /**
     *
     * @return URLWriter
     */
    public function getUrlWriter() {
        return $this->urlWriter;
    }

    /**
     *
     * @param URLWriter $urlWriter 
     */
    public function setUrlWriter(URLWriter $urlWriter) {
        $this->urlWriter = $urlWriter;
    }

    /**
     *
     * @return TemplateRenderer
     */
    public function getTemplateRenderer() {
        return $this->templateRenderer;
    }

    /**
     *
     * @param TemplateRenderer $templateRenderer 
     */
    public function setTemplateRenderer(TemplateRenderer $templateRenderer) {
        $this->templateRenderer = $templateRenderer;
    }
    
    /**
     *
     * @return Logger
     */
    public function getLogger() {
        return $this->logger;
    }

    /**
     *
     * @param Logger $logger 
     */
    public function setLogger(Logger $logger) {
        $this->logger = $logger;
    }
}
